Skip to main content

events-component

EventsComponent API

EventsComponent.setEvents
EventsComponent.setEvents(events: EconomicEvent[]): void

Sets the new event list.

Parameters
events: EconomicEvent[]
Returns
void
EventsComponent.setVisible
EventsComponent.setVisible(visible: boolean): void

Changes the component visibility.

Parameters
visible: boolean
Returns
void
EventsComponent.setEventTypeVisible
EventsComponent.setEventTypeVisible(eventsVisibility: Partial<Record<EventType, boolean>>): void

Changes visibility for the specific event type. For example, to turn off dividends visibility you can call this method with { dividends: false } argument

Parameters
eventsVisibility: Partial<Record<EventType, boolean>>
Returns
void
EventsComponent.observeEventHovered
EventsComponent.observeEventHovered(): Observable<EventWithId>

Observes hovered event when mouse moves in, and provides null when mouse moves out.

Returns
Observable<EventWithId>
;